<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>WebXRDepthSensing - Three.js Docs</title>
	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
	<script src="../scripts/highlight.min.js"></script>
	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
	<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
	<h1 translate="no">WebXRDepthSensing</h1>
		<section>
			<header>
				<div class="class-description"><p>A XR module that manages the access to the Depth Sensing API.</p></div>
			</header>
			<article>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="WebXRDepthSensing" translate="no">new <a href="#WebXRDepthSensing">WebXRDepthSensing</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new depth sensing module.</p>
						</div>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="depthFar" translate="no">.<a href="#depthFar">depthFar</a><span class="type-signature"> : number</span> </h3>
					<div class="description">
						<p>The depth near far.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="depthNear" translate="no">.<a href="#depthNear">depthNear</a><span class="type-signature"> : number</span> </h3>
					<div class="description">
						<p>The depth near value.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="mesh" translate="no">.<a href="#mesh">mesh</a><span class="type-signature"> : <a href="Mesh.html">Mesh</a></span> </h3>
					<div class="description">
						<p>A plane mesh for visualizing the depth texture.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="texture" translate="no">.<a href="#texture">texture</a><span class="type-signature"> : <a href="ExternalTexture.html">ExternalTexture</a></span> </h3>
					<div class="description">
						<p>An opaque texture representing the depth of the user's environment.</p>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="getDepthTexture" translate="no">.<a href="#getDepthTexture">getDepthTexture</a><span class="signature">()</span><span class="type-signature"> : <a href="ExternalTexture.html">ExternalTexture</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns a texture representing the depth of the user's environment.</p>
						</div>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> The depth texture.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="getMesh" translate="no">.<a href="#getMesh">getMesh</a><span class="signature">( cameraXR : <span class="param-type"><a href="ArrayCamera.html">ArrayCamera</a></span> )</span><span class="type-signature"> : <a href="Mesh.html">Mesh</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns a plane mesh that visualizes the depth texture.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>cameraXR</strong>
									</td>
									<td class="description last">
										<p>The XR camera.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> The plane mesh.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="init" translate="no">.<a href="#init">init</a><span class="signature">( depthData : <span class="param-type">XRWebGLDepthInformation</span>, renderState : <span class="param-type">XRRenderState</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Inits the depth sensing module</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>depthData</strong>
									</td>
									<td class="description last">
										<p>The XR depth data.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>renderState</strong>
									</td>
									<td class="description last">
										<p>The XR render state.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
					<h3 class="name name-method" id="reset" translate="no">.<a href="#reset">reset</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Resets the module</p>
						</div>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/src/renderers/webxr/WebXRDepthSensing.js" translate="no" target="_blank" rel="noopener">src/renderers/webxr/WebXRDepthSensing.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>